Add docstrings for all of the problem types #151
Conversation
Codecov Report
@@ Coverage Diff @@
## master #151 +/- ##
=======================================
Coverage 16.97% 16.97%
=======================================
Files 40 40
Lines 3016 3016
=======================================
Hits 512 512
Misses 2504 2504
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
| ### Fields | ||
|
|
||
| * `f`: The function for the ODE. | ||
| * `bc`: The boundary condition function. | ||
| * `u0`: The initial condition. Either the initial condition for the ODE as an | ||
| initial value problem, or a `Vector` of values for ``u(t_i)`` for collocation | ||
| methods | ||
| * `tspan`: The timespan for the problem. | ||
| * `p`: The parameters for the problem. Defaults to `NullParameters` | ||
| * `kwargs`: The keyword arguments passed onto the solves. |
There was a problem hiding this comment.
Maybe one could use DocStringExtensions.FIELDS and add docstrings to the fields in the struct definition below instead. Possibly that's more robust when modifying fields. When JuliaLang/julia#29478 is fixed it would also allow users to access docstrings of fields directly.
There was a problem hiding this comment.
Some of them use it, some of them don't. But I think that would be "perfect is the enemy of good" here, since I won't have the time to split them all up so I think I'll plan to merge and open issue about splitting out the fields docs.
There was a problem hiding this comment.
Sure, just wanted to mention it 🙂
| ## Mathematical Specification of a BVP Problem | ||
|
|
||
| To define a BVP Problem, you simply need to give the function ``f`` and the initial | ||
| condition ``u₀`` which define an ODE: |
| ## Mathematical Specification of an DAE Problem | ||
|
|
||
| To define a DAE Problem, you simply need to give the function ``f`` and the initial | ||
| condition ``u₀`` which define an ODE: |
No description provided.